package com.atxiaodei.swagger.swaggerdemo.config;

import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author wangmeng
 * @date 2020/9/17
 **/
@Configuration
@EnableSwagger2
public class SwaggerConfig{

    /**
     * @Description:swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
     */
    @Bean
    public Docket createRestApi() {


        return new Docket(DocumentationType.SWAGGER_2)
                // 是否启用Swagger
                .enable(true)
                // 用来创建该API的基本信息，展示在文档的页面中（自定义展示的信息）
                .apiInfo(apiInfo())
                // 设置哪些接口暴露给Swagger展示
                .select()
                // 扫描所有有注解的api，用这种方式更灵活
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                // 扫描指定包中的swagger注解
                //.apis(RequestHandlerSelectors.basePackage("com.atxiaodei.swagger.swaggerdemo.controller"))
                // 扫描所有 .apis(RequestHandlerSelectors.any())
                // 配置如何通过path过滤,即这里只扫描请求以/xiaodei开头的接口
                // .paths(PathSelectors.ant("/xiaodei/**"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * @Description: 构建 api文档的信息
     */
    //配置文档信息
    private ApiInfo apiInfo() {
        Contact contact = new Contact("小得", "http://xxx.xxx.com/联系人访问链接", "318418704@qq.com");


        return new ApiInfo("用户中心后端api接口文档",
                "欢迎访问用户中心接口文档，这里是描述信息",
                "v1.0",
                "http://terms.service.url/组织链接",
                contact,
                "Apach 2.0 许可",
                "");
    }

}